home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / off_09.zip / READER.OFF < prev    next >
Text File  |  1993-01-12  |  4KB  |  157 lines
  1. %startcol 10
  2. %endcol 70
  3. %parindent 0
  4. %defmacro off
  5. %bold OFF %norm %endmacro
  6. %defmacro title
  7. %norm 
  8. %verb
  9. %verb
  10. %endmacro
  11. %begin verb
  12.  -----------------------------------------------------------------------------
  13.  %bold __    ___  ___
  14.  /  \\  |__  |__
  15.  \\__/  |    |
  16. %norm
  17.  
  18.  An Informal Documentation Formatter
  19.  
  20.  -----------------------------------------------------------------------------
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27. %end
  28.  
  29. %center %rev READER'S GUIDE
  30.  
  31. %center %bold Vassilis V. Dimakopoulos
  32. %verb
  33. %verb
  34. %center --- Last Revision: May 1992 ---
  35. %norm
  36.  
  37. %newpage
  38. %center %under Quick overview 
  39. %title
  40.  
  41. To use %off make sure that %bold off.exe %norm is
  42. in a directory where MSDOS can find it (e.g. in one of the directories
  43. in your PATH variable). If you want to browse through the file 'fname'
  44. then type
  45.  
  46. %center off fname
  47.  
  48. When browsing through the document you can press the following keys:
  49.  
  50. %list
  51. %item SPACE or
  52. %item ENTER to go to the next page
  53. %item Q to quit the program.
  54. %endlist
  55.  
  56. %off can also save the document in a file or print it directly to a
  57. line printer.
  58.  
  59. %newpage
  60. %under %center Plain output
  61. %title
  62.  
  63. If you want to convert a document file into a plain - with no
  64. screen attributes - file then type:
  65.  
  66. %center off -a fname > newfname
  67.  
  68. and the file 'newfname' will contain plain ascii text. Note that the '-a'
  69. option is necessary because the normal output of %off %under cannot 
  70. %norm be redirected to a file.
  71.  
  72. %title
  73. %center %under Printer output
  74. %title
  75.  
  76. %off can sent a document file directly to a %under line %norm printer
  77. (which supports the IBM escape sequences) using the '-p' option:
  78.  
  79. %center off -p fname
  80.  
  81. %under NOTES: %norm 
  82.  
  83. %list 1
  84. %item The characters that appear with reversed background / foreground 
  85.       on the screen, appear as %rev italics %norm on the line printer. 
  86.       
  87. %item %off assumes by default that a %bold NLQ %norm (Near-Letter-Quality)
  88.       printing is needed. To override this use the '-d' option:
  89.       
  90.       %center off -p -d fname
  91.       
  92.       and the printer will use %bold draft %norm quality characters.
  93.       
  94. %item While the screen output is the default for %off (and consequently
  95.       the page length is 24 lines), when the '-p' or '-a' option is used,
  96.       the page length becomes by default %bold 66 %norm lines. You may need 
  97.       to adjust this to your printer page length (or to whatever you want) 
  98.       using the '-l' option. For example
  99.       
  100.       %center off -p -l 54 fname
  101.       
  102.       will set the page length to a usual single-sheet printer page.
  103.  
  104. %item Similarly the '-p' and '-a' options cause the page width to be
  105.       initialized to 91 columns. Adjust this with the '-w' option, e.g.
  106.       
  107.       %center off -p -w 80 fname
  108. %endlist
  109.  
  110. Note that the '-d' option is ignored if the '-p' option is not used and
  111. that the '-l' and '-w' options can be used not only for printer but for 
  112. screen output too.
  113.  
  114. %newpage
  115. %center %under Filenames
  116. %title
  117.  
  118. To browse through 'fname' you do not need to specify an extension. 
  119. If you give one %off will take it into consideration otherwise it 
  120. will supply some extensions by itself. The extensions 
  121. %off gives to 'fname' (in the order shown) are
  122.  
  123. %list 1
  124. %item The user extension (if any given)
  125. %item .off
  126. %item .doc
  127. %item .txt
  128. %endlist
  129.  
  130. Also you do not have to give the full path on which 'fname' resides.
  131. %off will first look for an environmental variable called
  132. %bold OFFPATH %norm which has the directories where the documentation 
  133. files can normaly be found. Then %off will search for 'fname' in the 
  134. following directories (in the order shown):
  135.  
  136. %list 1
  137. %item The current directory.
  138. %item The directories in your %bold OFFPATH %norm (if it exists).
  139. %endlist
  140.  
  141. Note that %off will search in the following manner:
  142.  
  143. %begin verb
  144.             for each extension
  145.             {
  146.               for each directory
  147.               {
  148.                 if "directory\\file.extension" found
  149.                   then Done.
  150.                 else
  151.                   Continue.
  152.               }
  153.             }
  154.  
  155. %end
  156.  
  157.